kanzi::PropertyType< Type, typename > Class Template Reference

Property type represents a property type for the property system. More...

#include <kanzi/core/property/property_type.hpp>

Public Types
typedef Type	DataType
typedef PropertyTypeDescriptor< Type >	Descriptor
typedef PropertyTypeDescriptor< Type >::Traits	Traits

Public Member Functions
	PropertyType (FixedString name)
	PropertyType (MetadataGeneratedName name)
	PropertyType (FixedString name, DataType defaultValue, uint32_t changeFlags, bool inheritable)
	PropertyType (MetadataGeneratedName name, DataType defaultValue, uint32_t changeFlags, bool inheritable)
	PropertyType (FixedString name, DataType defaultValue, uint32_t changeFlags, bool inheritable, PropertyTypeEditorInfo *editorInfo)
	PropertyType (MetadataGeneratedName name, DataType defaultValue, uint32_t changeFlags, bool inheritable, PropertyTypeEditorInfo *editorInfo)
	~PropertyType ()
	operator AbstractPropertyType () const
Traits::ReturnType	getDefaultValue () const
	Returns the default value for the property type. More...
const char *	getName () const
	Returns the fully qualified name of the property type in form "Class.PropertyType". More...
const char *	getUnqualifiedName () const
	Returns the unqualified name of the property type in form "PropertyType", where the qualified name is "Class.PropertyType". More...
PropertyDataType	getDataType () const
	Returns the data type of the property type. More...
bool	isInherited () const
	Returns true if the property type is inheritable, false otherwise. More...
uint32_t	getChangeFlags () const
	Returns the change flags of the property type. More...
PropertyTypeEditorInfoSharedPtr	getEditorInfo () const
	Returns the editor information of the property type. More...
Descriptor *	get () const

Protected Member Functions
	PropertyType ()

Friends
class	Object
class	Node
class	AbstractPropertyType
class	DynamicPropertyType< Type >

Detailed Description

template<typename Type, typename = void>
class kanzi::PropertyType< Type, typename >

Property type represents a property type for the property system.

You can use PropertyType class to define a property type. Instances of PropertyType uniquely identify property types in functions that operate on properties.

Member Typedef Documentation

template<typename Type, typename = void>

typedef Type kanzi::PropertyType< Type, typename >::DataType

template<typename Type, typename = void>

typedef PropertyTypeDescriptor<Type> kanzi::PropertyType< Type, typename >::Descriptor

template<typename Type, typename = void>

typedef PropertyTypeDescriptor<Type>::Traits kanzi::PropertyType< Type, typename >::Traits

Constructor & Destructor Documentation

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::PropertyType ( FixedString  name )

inlineexplicit

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::PropertyType ( MetadataGeneratedName  name )

inlineexplicit

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::PropertyType ( FixedString  name, DataType  defaultValue, uint32_t  changeFlags, bool  inheritable  )

inlineexplicit

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::PropertyType ( MetadataGeneratedName  name, DataType  defaultValue, uint32_t  changeFlags, bool  inheritable  )

inlineexplicit

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::PropertyType ( FixedString  name, DataType  defaultValue, uint32_t  changeFlags, bool  inheritable, PropertyTypeEditorInfo *  editorInfo  )

inlineexplicit

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::PropertyType ( MetadataGeneratedName  name, DataType  defaultValue, uint32_t  changeFlags, bool  inheritable, PropertyTypeEditorInfo *  editorInfo  )

inlineexplicit

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::~PropertyType ( )

inline

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::PropertyType ( )

inlineexplicitprotected

Member Function Documentation

template<typename Type, typename = void>

kanzi::PropertyType< Type, typename >::operator AbstractPropertyType ( ) const

inline

template<typename Type, typename = void>

Traits::ReturnType kanzi::PropertyType< Type, typename >::getDefaultValue ( ) const

inline

Returns the default value for the property type.

The default value is returned by getProperty functions when no other value is available.

template<typename Type, typename = void>

const char* kanzi::PropertyType< Type, typename >::getName ( ) const

inline

Returns the fully qualified name of the property type in form "Class.PropertyType".

template<typename Type, typename = void>

const char* kanzi::PropertyType< Type, typename >::getUnqualifiedName ( ) const

inline

Returns the unqualified name of the property type in form "PropertyType", where the qualified name is "Class.PropertyType".

template<typename Type, typename = void>

PropertyDataType kanzi::PropertyType< Type, typename >::getDataType ( ) const

inline

Returns the data type of the property type.

The data type of the property type defines the data representation type of each property value, for example float.

template<typename Type, typename = void>

bool kanzi::PropertyType< Type, typename >::isInherited ( ) const

inline

Returns true if the property type is inheritable, false otherwise.

Inheritable property types provide values for all objects down the hierarchy.

template<typename Type, typename = void>

uint32_t kanzi::PropertyType< Type, typename >::getChangeFlags ( ) const

inline

Returns the change flags of the property type.

Change flags can indicate that particular aspect of an object should be invalidated when you modify a property, for example layout.

template<typename Type, typename = void>

PropertyTypeEditorInfoSharedPtr kanzi::PropertyType< Type, typename >::getEditorInfo ( ) const

inline

Returns the editor information of the property type.

template<typename Type, typename = void>

Descriptor* kanzi::PropertyType< Type, typename >::get ( ) const

inline

Friends And Related Function Documentation

template<typename Type, typename = void>

friend class Object

friend

template<typename Type, typename = void>

friend class Node

friend

template<typename Type, typename = void>

friend class AbstractPropertyType

friend

template<typename Type, typename = void>

friend class DynamicPropertyType< Type >

friend

---

The documentation for this class was generated from the following file:

• kanzi/core/property/property_type.hpp